Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Additional case handling for color parameter in search API #22692

Merged
merged 6 commits into from
Sep 23, 2024
Merged

Additional case handling for color parameter in search API #22692

merged 6 commits into from
Sep 23, 2024

Conversation

chrstinalin
Copy link
Contributor

Fixes: mozilla/addons#15022

Description

Handles cases as follows --

  1. The empty color parameter is ignored.
  2. Otherwise, take the first 6 characters of the color parameter (after removing the #, if any). 3-character hex codes (ex. #aaa) still pass.
  3. Throw ValueError if the value is still unparseable as a hex code.

Testing

Directly use the search function for static themes, or to the API directly, ex.
http://olympia.test/api/v5/addons/search/?type=statictheme&color=336699aa

Checklist

  • Add #ISSUENUM at the top of your PR to an existing open issue in the mozilla/addons repository.
  • Successfully verified the change locally.
  • The change is covered by automated tests, or otherwise indicated why doing so is unnecessary/impossible.
  • Add before and after screenshots (Only for changes that impact the UI).
  • Add or update relevant docs reflecting the changes made.

@chrstinalin
When searching themes by color: ignore empty color parameters, ignore…
775e153 
… alpha value of hex string, throw error if otherwise unparseable
@sentry-io Sentry.io
Copy link

sentry-io bot commented Sep 20, 2024

🔍 Existing Issues For Review

Your pull request is modifying functions with the following pre-existing issues:

📄 File: src/olympia/search/filters.py

Function Unhandled Issue
get_es_query TypeError: hsl() takes 3 positional arguments but 4 were given /api/v5/...
Event Count: 5
get_es_query TypeError: hsl() missing 3 required positional arguments: 'r', 'g', and 'b' /...
Event Count: 1

Did you find this useful? React with a 👍 or 👎

@chrstinalin chrstinalin marked this pull request as draft September 20, 2024 19:27
@chrstinalin chrstinalin marked this pull request as ready for review September 20, 2024 21:24
@chrstinalin chrstinalin requested review from a team and diox and removed request for a team September 20, 2024 21:24
diox
diox reviewed Sep 23, 2024
View reviewed changes
src/olympia/search/filters.py Outdated Show resolved Hide resolved
src/olympia/search/tests/test_filters.py Show resolved Hide resolved
@chrstinalin chrstinalin merged commit f577626 into mozilla:master Sep 23, 2024
31 checks passed
@diox diox modified the milestone: 2024.10.03 Sep 23, 2024
@sentry-io Sentry.io
Copy link

sentry-io bot commented Sep 24, 2024

Suspect Issues

This pull request was deployed and Sentry observed the following issues:

  • ‼️ TypeError: hsl() missing 3 required positional arguments: 'r', 'g', and 'b' /api/v5/addons/search/ View Issue

Did you find this useful? React with a 👍 or 👎

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@diox diox diox approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

[Bug]: Some values of the color parameter in search API trigger a 500
2 participants
@chrstinalin @diox